SuperHack/SuperHack CD.bin/SCRIPTZ/OMEN.ZIP/Addon.faq

Text File | 1996-09-08 | 10KB | 243 lines

mirc addon faq .04 - concept by [x|x] and webba
-----------------------------------------------------------------------------
re: Now before you say blah blah this sucks here me out.
    Read it determine its usefullness and use it or toss it.
-----------------------------------------------------------------------------

Note to scripters:
In order to add compatibility for addons in your script you need:

1. %VER variable containg your scripts version
2. An /ADDON directory off of your main MIRC directory
3. Install the alias /SLOAD below
load {
  if (%ver == $null) {
    echo 4 $active This is a non-compliant script, load failed.
    halt
  }
  elseif (( $right(5,$1) == .mirc ) || ( $right(4,$1) == .mir )) {
    play -c $me $mircdir $+ addon\ $+ $1 0
    goto end
  }
  else /load $1 $2
  }
  else {
    echo 4 $active Unsupported extension, load failed.
  }
  :end
}

Thats IT! Do those 3 things and all your scripts will be compatible
with addons.


Questions and Answers:

Q: What is this MIRC ADDON STUFF?

A:
This 'standard' allows mirc scripters and users use addon files like ircii
and many clients allow you to do. Type /load whatever.mirc and boom you have
an extra something to any script. This CAN be abused so i suggest you LOOK
before you /load ANY .mirc file. With this 'standard' we can also /unload
the aliases and sections the author of the .mirc added to your ini's.

Q: Why do you suppose we want to /load these .mirc's instead of using scripts?

A:
Well the main point of mirc is for ppl to SCRIPT their own main scripts.
Also there are MANY real bad scripting jobs out there. So this allows you
to have the extras other may have thought of without RIPPING to your own script.
Ripping is running rampant in mirc scripts. But nonetheless soemtimes needed
for example. This 'standard' allows you to TEST someones addon and if you dont
like it /unload. WITHOUT MAKING MAJOR INI CHANGES. Thats the key point.
I have about 100+ dirs of mirc scripts on my hd. Just from testing and looking
at them. enough said?

Q: Why do YOU propose this (question directed towards xix and webba for the concept)

A: Personally if i was new to mirc i would want something like this so i
would not be confused or overwhelmed by mirc in general. Mirc is much more powerful
now and new ppl have a hard time finding something that suits them.
This does not abolish scripts it just lets us all as mirc users enjoy the fruits
of someone elses labor. I would have used this concept if ANYONE else had thought
of it because im sure others have but not implemented on a wide scale. So with
that in mind make the decision yourself. :P

Q: How do i add support for addons to my ini/script?

A: Several ways have been tried and tested. I will show a few below. It can be
simple alias or a multilined if alias. You choose what suits you best.
Also NOTE that there is already a /LOAD command in mirc and this command overrides
the default /load. One of these below ALLOWS both internal and addon LOADING.

THESE WOULD GO IN YOUR ALIAS SECTION:

Simple method(no error checking or internal load support)

load { play -c $me $mircdir $+ *1 | :end }

Advanced method(error checking and internal load support)

load {
  if (%ver == $null) {
    echo 4 $active This is a non-compliant script, load failed.
    halt
  }
  elseif (( $right(5,$1) == .mirc ) || ( $right(4,$1) == .mir )) {
    play -c $me $mircdir $+ addon\ $+ $1 0
    goto end
  }
  elseif ($right(4,$2) == .ini) {
    /load $1 $2
  }
  else {
    echo 4 $active Unsupported extension, load failed.
  }
  :end
}

Q: Ok how about the /unload part?

A: The /unload would be written IN THE ADDON itself you dont have to add support
for it because a proper addon will have an /unload command and notify you of the
exact syntax.

Q: Any other special conditions some addons MAY need?

A: Debate this all you like but here it is  :P
We propose all scripts carry a %VER variable that stores the version reply.
If that is not suitable thats ok im sure as people make scripts the will do
as they like. BUT note this: if you add %VER support the authors of the
addons will be able to append themselves to your version reply.
This has benefits and drawbacks. Out of respect to the author of the addon
you should allow them to append to your version reply thus giving them credit
of some sort. This also lets others see that you have certain addons they may
be looking for. And the politics of irc dictate addons are just plain cool.
Haha. The drawbacks can be poor coded addons appends to your version reply
a long drawn out plain idiotic reply. I propose you allow %VER but check the addon
before /loading to make sure the author didnt do somethign stupid.

HERE IS AN EXAMPLE OF A VARIABLE DRIVEN VERSION REPLY
THIS WOULD GO IN YOUR COMMANDS SECTION:
(please add FLOOD protection in this alias to your liking)

1:VERSION {
  raw -r NOTICE $nick :
VERSION %ver $+ 

}



Q: What about other remote commands such as raw and popups?

A: This CAN be done very easily. With $readini and /writeini. Also
mirc allows you to $dde it to get the main ini name so you can look in that
ini for the raw= etc. This is not hard to figure out yet a bit tasking to
to complete. Ill show a breif example of adding a line to the users raw ini.

TO ADDON AND REMOVE TO RAW EVENTS (as an example)

THE ADDING PART:
set %raw $readini $dde mirc inifile "" Files raw
save -r %raw $+ .bak
%tmp = $lines(%raw) - 2
writeini %raw Raw r $+ %tmp $+ =391:* { if $parm2 == $server { %lag = $ctime - %lag | goto end } | %slag = $ctime - %slag | echo %h $active %b $chr(91) $+  $+ $parm2 $+  $+ $chr(93) $+ : %slag seconds | :end }

THE REMOVAL:
remove %raw
load -r %raw $+ .bak

Thx to El_Barto and webba for some more great ideas here.

Q: How the heck do i make an addon?

A: Well the addon idea is based on the new /alias command that khaled so
kindly gave us with mirc 4.5?+
You can define new aliases by doing /alias <aliasname> <alias commands here>
Now keep in mind the /load command is PLAYING the addon as a commands file.
So a file with say:
          alias cls { clear }
Would be played as a command and thus ADDING that alias to your alias ini.
Also by playing the addon as a command authors can echo that it is loading
and check for %ver support etc.
This is all fine and dandy but if youll notice some other lil tweaking is
needed to make a successful addon. The way mirc is now it interperts all the
evaluators immediatly. Like if you add an alias like:
    alias test { say $1 was a test }
Mirc will add to your alias ini:
alias???=test say was a test
Notice the $1 is not in there! Well with $chr(?) you can work around this
very easily. :P

I will show you an example from webba's wkick.mirc addon:

echo 6 $active <-WK-> Now loading WKiCKS.mirc...
/alias wk1 me looks at $chr(36) $+ 1 And Shake's His Head... $chr(124) say YOU'RE A KID, THIS DON'T LOOK LIKE #DUMBKIDS TO ME!@ $chr(124) kick $chr(35) $chr(36) $+ 1 WKiCKS)( KiDDy KiCK
/alias unloadwk alias wk1 $chr(124) alias unloadwk $chr(124) echo 6 <-WK-> WKiCKS Unloaded succesfully.
echo 6 $active <-WK-> WKiCKS Loaded SUCCESSFULLY, to unload type /unloadwk.

Very simply put everything you want to do CAN be done.

Q: This /alias command how do we delete the aliases we add to our addons?

A: Well as an addon author if you do an alias as i mentioned before:
alias cls { clear }
It is now in the alias ini. To remove simply do:
alias cls
And that would remove that particular alias.
So when writing and UNLOAD alias
it might look as so:
/unloadtest alias cls $chr(124) alias test

Let me explain a lil simpler - $chr(124) is the | character since you cant
play the | as a command it has to be added as $chr(124)
Also that unloadtest alias did two things
deleted the alias cls
and deleted the alias test


Q: In my addon how do i check for and add to %ver if it exists?

A: Ill show some small examples of how to add to and error check for %VER.

if %ver == $null { play stop }
The above obviously says if %ver does not exist dont load the addon.

if blah.mirc !isin %ver { %ver = %ver $chr(43) blah.mirc by bleh }
The above says if blah.mirc is not in the %ver reply go ahead and append to
the %ver version reply variable.

Non compliant scripts get this from my addons:
if %ver == $null { echo 4 Sorry +geek+ dont like nonaddon compliant scripts...GET the addon.faQ and add support! Get the faQ at http://www.geocities.com/TimesSquare/3873/irc.html | play stop }

Q: What are some of the limitations the addons and mirc have?

A: Well good question. Heres what i can tell you so far.
You have to replace all internal evaluators and strings with $chr(#)
Like even $active for example has to be written in the addon as $chr(36) $+ active
And in some cases (depending on where the evaluator fits) even $+
has to be replaced as $chr(36) $+ +
I think you get the idea. If something is not working and you cant figure out
why $chr(#) is probably the answer.


Q: What other things can i add to my script to make it nice?

A: A lotta ircii scripts have ascii's of there logo. They are nice looking
way to announce your script is loaded and a good way to include credits
and help instructions. A WELL WRITTEN addon is what ppl want. Include help
and the UNLOAD MUST UNDO ALL CHANGES DONE or its useless ppl wont like it
or load it again. This also revives mircs younger days when ppl were pumped
about just irc in general. Stupid lil fun addons are what i am looking for
there isnt that many around. Of course war addons are always NIZE too. ;)
Possibly a dalnet/undernet addon. An addon to have all the eggdrop commands
and kick addons are fun. Theres a number of possibilities there is no limit.

I hope you take the time to check out the usefullness of addons and
making mirc a more friendly and more powerful irc environment.

                                        - peace [x|x] & webba

You can always find the latest of this faQ and addons at:
           http://www.geocities.com/TimesSquare/3873/irc.html